Get one or more kiosks by id

GET 
/kiosks

Get one or more kiosks by id

Request

Query Parameters

pageSize integer

Default value: 25

The number of results per page

page integer

Default value: 1

The page of results to return

id string[]required

Header Parameters

x-api-key base64 encodedrequired

Your api key for OneBasket

Responses

200

The request has succeeded.

application/json

Schema

Schema

Page integerrequired

The current page of results

PageSize integerrequired

The number of results per page

PageTotal integerrequired

The total number of pages

ResultsTotal integerrequired

The total number of results

HasNextPage booleanrequired

True if there is a next page

HasPreviousPage booleanrequired

True if there is a previous page

Results object[]required
The results for the current page
Array [
Id stringrequired
The id of the kiosk
Name stringrequired
The name of the kiosk
Description stringrequired
The description of the kiosk
Address stringrequired
The address of the kiosk
Postcode stringrequired
The postcode of the kiosk
]

Example (from schema)

{
  "Page": 0,
  "PageSize": 0,
  "PageTotal": 0,
  "ResultsTotal": 0,
  "HasNextPage": true,
  "HasPreviousPage": true,
  "Results": [
    {
      "Id": "string",
      "Name": "string",
      "Description": "string",
      "Address": "string",
      "Postcode": "string"
    }
  ]
}

400

The server could not understand the request due to invalid syntax.

application/json

Schema

Schema

detail stringrequired
extensions objectrequired
instance stringrequired
status numberrequired

Possible values: [400]

title stringrequired

Possible values: [Bad request]

type stringrequired

Example (from schema)

{
  "detail": "string",
  "extensions": {},
  "instance": "string",
  "status": 400,
  "title": "Bad request",
  "type": "string"
}

401

Access is unauthorized.

application/json

Schema

Schema

detail stringrequired
extensions objectrequired
instance stringrequired
status numberrequired

Possible values: [401]

title stringrequired

Possible values: [Unauthorized]

type stringrequired

Example (from schema)

{
  "detail": "string",
  "extensions": {},
  "instance": "string",
  "status": 401,
  "title": "Unauthorized",
  "type": "string"
}

Loading...